Projector: Zero-Dependency CLI Tool for AI Codebase Analysis
Projector does something seemingly simple: it reads and concatenates file contents from a specified directory. But the beauty lies in its thoughtful implementation and the practical problems it solves.
What Makes Projector Different?
While it might seem like a straightforward task, Projector is designed to do it intelligently. It's not just a basic file concatenator, it’s a tool built specifically to help AI better understand your codebase.
- Smart Filtering and Ignoring: Easily include only the file types you care about (like
.py
or.js
files) while automatically excluding common directories or any other patterns you specify. - Clear, Organized Output: Each file is neatly separated with a clear path header, so the AI can easily see where each piece of code comes from.
- Preview Before You Commit: The dry-run feature lets you see exactly which files will be processed before you run the main command, so there are no surprises.
The Power of Context for AI
When you give an AI a clean, complete view of your project, you're not just giving it code snippets - you're providing it with context. This allows it to:
- Understand Architecture: The AI can see how different files and modules connect, helping it grasp the overall structure and design of your project.
- Improve Suggestions and Reviews: With the full picture, an AI can provide more accurate code suggestions, identify subtle bugs, and perform more holistic code reviews.
- Generate Better Documentation: When an AI can see the entire project, it can create more comprehensive and accurate documentation.
How to Get Started
Projector is easy to install and has no dependencies, so you can start using it right away.
pip install .
To create a clean text file of all your Python and Markdown files, while ignoring node_modules
and .git
, just run a simple command:
projector . -i node_modules .git -e .py .md -o project_overview.txt
Check the GitHub repo here.
Simple Tool, Big Impact
"Simplicity is the ultimate sophistication."
-- Clare Boothe Luce (not Leonardo da Vinci)
In a world where development tools are becoming more complex, Projector stands out by offering a focused, simple solution to a very real problem. It proves that sometimes the most impactful solutions are also the simplest.